home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / library / p61lib.lha / P61Lib / Docs / p61.doc next >
Text File  |  1995-11-08  |  4KB  |  128 lines
  1. TABLE OF CONTENTS
  2.  
  3. player61.library/pl61_Inquire
  4. player61.library/pl61_Play
  5. player61.library/pl61_SetPos
  6. player61.library/pl61_SetVol
  7. player61.library/pl61_Stop
  8. player61.library/pl61_Inquire                      player61.library/pl61_Inquire
  9.  
  10.    NAME
  11.        pl61_Inquire -- get a pointer to the replayer's status block.
  12.  
  13.    SYNOPSIS
  14.        statusblock = pl61_Inquire( )
  15.        D0
  16.  
  17.        struct p61status * pl61_Inquire( void );
  18.  
  19.    FUNCTION
  20.        Get a pointer to the replayer's status block. This block is mostly
  21.        read-only; you CAN write to the volume, tempo and play fields, and
  22.        the replayer will react to your changes. The other fields should
  23.        generally only be read from.
  24.  
  25.    RESULT
  26.        statusblock - pointer to the replayer's internal status block.
  27.  
  28. player61.library/pl61_Play                            player61.library/pl61_Play
  29.  
  30.    NAME
  31.        pl61_Play -- Play a p61 module.
  32.  
  33.    SYNOPSIS
  34.        error = pl61_Play( module,sampledata,samplebuffer )
  35.        D0                A0     D1         D0
  36.  
  37.        LONG pl61_Play( APTR,APTR,APTR );
  38.  
  39.    FUNCTION
  40.        Initialize the replayer and start playing the given module.
  41.        Unpack samples into the given samplebuffer if necessary.
  42.  
  43.    INPUTS
  44.        module       - pointer to a P61 module.
  45.        sampledata   - pointer to the module's samples, or NULL if the
  46.                       samples follow the module.
  47.        samplebuffer - pointer to a buffer into which the sample data should
  48.                       be unpacked into, or NULL if the samples are not
  49.                       packed. Make sure the buffer is large enough to hold
  50.                       the unpacked data!
  51.  
  52.    RESULT
  53.        error - if the replayer started successfully, this will be NULL.
  54.                If for whatever reason the replayer failed to start, this
  55.                will be non-NULL.
  56.  
  57.    NOTES
  58.        Make sure the final sample buffer is in CHIP RAM! If the samples
  59.        follow the module, the module buffer should be in CHIP RAM; if the
  60.        samples come in their own buffer, that buffer should be in CHIP RAM;
  61.        if they are packed, the buffer to unpack into should be in CHIP RAM.
  62.  
  63.    SEE ALSO
  64.        pl61_Stop()
  65.  
  66. player61.library/pl61_SetPos                        player61.library/pl61_SetPos
  67.  
  68.    NAME
  69.        pl61_SetPos -- jump to the given module position.
  70.  
  71.    SYNOPSIS
  72.        pl61_SetPos( position )
  73.                    D0
  74.  
  75.        void pl61_SetPos( WORD );
  76.  
  77.    FUNCTION
  78.        Jumps to the specified position in the module, if the replayer is
  79.        running.
  80.  
  81.    NOTES
  82.        Don't call this if pl61_Play() didn't succeed, or if you never called
  83.        pl61_Play()!
  84.  
  85.    SEE ALSO
  86.        pl61_Play()
  87.  
  88. player61.library/pl61_SetVol                        player61.library/pl61_SetVol
  89.  
  90.    NAME
  91.        pl61_SetVol -- set the master volume.
  92.  
  93.    SYNOPSIS
  94.        pl61_SetVol( volume )
  95.                    D0
  96.  
  97.        void pl61_SetVol( WORD );
  98.  
  99.    FUNCTION
  100.        Set the master volume (the volume field in the p61status structure)
  101.        to the given value. This is safe to call whether or not the replayer
  102.        is actually running.
  103.  
  104.    SEE ALSO
  105.        pl61_Inquire()
  106.  
  107. player61.library/pl61_Stop                            player61.library/pl61_Stop
  108.  
  109.    NAME
  110.        pl61_Stop -- stop the replayer.
  111.  
  112.    SYNOPSIS
  113.        pl61_Stop( )
  114.  
  115.        void pl61_Stop( void );
  116.  
  117.    FUNCTION
  118.        If the replayer was started successfully with pl61_Play(), this
  119.        function turns the replayer off and deallocates all resources.
  120.  
  121.    NOTES
  122.        Don't call this if pl61_Play() didn't succeed, or if you never called
  123.        pl61_Play()!
  124.  
  125.    SEE ALSO
  126.        pl61_Play()
  127.  
  128.